<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html>
        <head>
          <title>scalation.random</title>
          <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
          
      <link type="text/css" media="screen" rel="stylesheet" href="../../lib/template.css" />
      <script type="text/javascript" src="../../lib/jquery.js"></script>
      <script type="text/javascript" src="../../lib/jquery-ui.js"></script>
      <script type="text/javascript" src="../../lib/template.js"></script>
      <script type="text/javascript" src="../../lib/tools.tooltip.js"></script>
    
        </head>
        <body class="value">
      <div id="definition">
        <img src="../../lib/package_big.png" />
        <p id="owner"><a name="scalation" class="extype" href="../package.html">scalation</a></p>
        <h1>random</h1>
      </div>

      <h4 class="signature" id="signature">
      <span class="kind">package</span>
      <span class="symbol"> 
        <span class="name">random</span>
        
        
      </span>
      </h4>
      
          <div class="fullcommenttop" id="comment"></div>
        

      <div id="template">

        <div id="mbrsel">
          <div id="textfilter"><span class="pre"></span><span class="input"><input accesskey="/" type="text" /></span><span class="post"></span></div>
          
          
          <div id="visbl">
              <span class="filtertype">Visibility</span>
              <ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
            </div>
        </div>

        

        <div class="types members" id="types">
              <h3>Type Members</h3>
              <ol><li visbl="pub" name="scalation.random.Bernoulli" data-isabs="false">
      <a id="Bernoulli:Bernoulli"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Bernoulli.html"><span class="name">Bernoulli</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Bernoulli random variates.</p>
    </li><li visbl="pub" name="scalation.random.Beta" data-isabs="false">
      <a id="Beta:Beta"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Beta.html"><span class="name">Beta</span></a>
        
        <span class="params">(<span name="alpha">alpha: Double</span>, <span name="beta">beta: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Beta random variates.</p>
    </li><li visbl="pub" name="scalation.random.Binomial" data-isabs="false">
      <a id="Binomial:Binomial"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Binomial.html"><span class="name">Binomial</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="n">n: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Binomial random variates.</p>
    </li><li visbl="pub" name="scalation.random.Cauchy" data-isabs="false">
      <a id="Cauchy:Cauchy"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Cauchy.html"><span class="name">Cauchy</span></a>
        
        <span class="params">(<span name="alpha">alpha: Double</span>, <span name="beta">beta: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Cauchy (or Lorentz) random variates.</p>
    </li><li visbl="pub" name="scalation.random.ChiSquare" data-isabs="false">
      <a id="ChiSquare:ChiSquare"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="ChiSquare.html"><span class="name">ChiSquare</span></a>
        
        <span class="params">(<span name="df">df: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates ChiSquare random variates.</p>
    </li><li visbl="pub" name="scalation.random.Deterministic" data-isabs="false">
      <a id="Deterministic:Deterministic"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Deterministic.html"><span class="name">Deterministic</span></a>
        
        <span class="params">(<span name="x">x: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Deterministic random variates.</p>
    </li><li visbl="pub" name="scalation.random.Discrete" data-isabs="false">
      <a id="Discrete:Discrete"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Discrete.html"><span class="name">Discrete</span></a>
        
        <span class="params">(<span name="dist">dist: VectorD</span>, <span name="x">x: VectorD</span>, <span name="cumulative">cumulative: Boolean</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates generalized Discrete random variates for a given
distribution specified using either a probability mass function (pmf)
or a cumulative distribution function (cdf).</p>
    </li><li visbl="pub" name="scalation.random.Erlang" data-isabs="false">
      <a id="Erlang:Erlang"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Erlang.html"><span class="name">Erlang</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="k">k: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Erlang random variates.</p>
    </li><li visbl="pub" name="scalation.random.Exponential" data-isabs="false">
      <a id="Exponential:Exponential"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Exponential.html"><span class="name">Exponential</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Exponential random variates.</p>
    </li><li visbl="pub" name="scalation.random.Fisher" data-isabs="false">
      <a id="Fisher:Fisher"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Fisher.html"><span class="name">Fisher</span></a>
        
        <span class="params">(<span name="df1">df1: Int</span>, <span name="df2">df2: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Fisher (F-Distribution) random variates.</p>
    </li><li visbl="pub" name="scalation.random.Gamma" data-isabs="false">
      <a id="Gamma:Gamma"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Gamma.html"><span class="name">Gamma</span></a>
        
        <span class="params">(<span name="alpha">alpha: Double</span>, <span name="beta">beta: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Gamma random variates.</p>
    </li><li visbl="pub" name="scalation.random.Geometric" data-isabs="false">
      <a id="Geometric:Geometric"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Geometric.html"><span class="name">Geometric</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Geometric random variates.</p>
    </li><li visbl="pub" name="scalation.random.HyperExponential" data-isabs="false">
      <a id="HyperExponential:HyperExponential"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="HyperExponential.html"><span class="name">HyperExponential</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="mu1">mu1: Double</span>, <span name="mu2">mu2: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates HyperExponential random variates (two rates).</p>
    </li><li visbl="pub" name="scalation.random.HyperGeometric" data-isabs="false">
      <a id="HyperGeometric:HyperGeometric"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="HyperGeometric.html"><span class="name">HyperGeometric</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="n">n: Int</span>, <span name="pop">pop: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates HyperGeometric random variates.</p>
    </li><li visbl="pub" name="scalation.random.LogNormal" data-isabs="false">
      <a id="LogNormal:LogNormal"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="LogNormal.html"><span class="name">LogNormal</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="sigma2">sigma2: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates LogNormal random variates.</p>
    </li><li visbl="pub" name="scalation.random.Multinomial" data-isabs="false">
      <a id="Multinomial:Multinomial"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Multinomial.html"><span class="name">Multinomial</span></a>
        
        <span class="params">(<span name="p">p: Array[Double]</span>, <span name="n">n: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Multinomial random variates.</p>
    </li><li visbl="pub" name="scalation.random.NegativeBinomial" data-isabs="false">
      <a id="NegativeBinomial:NegativeBinomial"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="NegativeBinomial.html"><span class="name">NegativeBinomial</span></a>
        
        <span class="params">(<span name="p">p: Double</span>, <span name="s">s: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates NegativeBinomial random variates.</p>
    </li><li visbl="pub" name="scalation.random.Normal" data-isabs="false">
      <a id="Normal:Normal"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Normal.html"><span class="name">Normal</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="sigma2">sigma2: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Normal (Gaussian) random variates.</p>
    </li><li visbl="pub" name="scalation.random.Poisson" data-isabs="false">
      <a id="Poisson:Poisson"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Poisson.html"><span class="name">Poisson</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Poisson random variates (discrete).</p>
    </li><li visbl="pub" name="scalation.random.Randi" data-isabs="false">
      <a id="Randi:Randi"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Randi.html"><span class="name">Randi</span></a>
        
        <span class="params">(<span name="a">a: Int</span>, <span name="b">b: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Randi random variates (random integers).</p>
    </li><li visbl="pub" name="scalation.random.Random" data-isabs="false">
      <a id="Random:Random"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Random.html"><span class="name">Random</span></a>
        
        <span class="params">(<span name="stream">stream: Int</span>)</span><span class="result"> extends Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">This class generates random real numbers in the range (0, 1).</p>
    </li><li visbl="pub" name="scalation.random.StudentT" data-isabs="false">
      <a id="StudentT:StudentT"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="StudentT.html"><span class="name">StudentT</span></a>
        
        <span class="params">(<span name="df">df: Int</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates StudentT random variates.</p>
    </li><li visbl="pub" name="scalation.random.Triangular" data-isabs="false">
      <a id="Triangular:Triangular"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Triangular.html"><span class="name">Triangular</span></a>
        
        <span class="params">(<span name="a">a: Double</span>, <span name="b">b: Double</span>, <span name="c">c: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates simple Triangular random variates with the mode in the middle.</p>
    </li><li visbl="pub" name="scalation.random.Uniform" data-isabs="false">
      <a id="Uniform:Uniform"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Uniform.html"><span class="name">Uniform</span></a>
        
        <span class="params">(<span name="a">a: Double</span>, <span name="b">b: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Uniform random variates in the range (a, b).</p>
    </li><li visbl="pub" name="scalation.random.Variate" data-isabs="true">
      <a id="Variate:Variate"></a>
      <h4 class="signature">
      <span class="kind">class</span>
      <span class="symbol"> 
        <a href="Variate.html"><span class="name">Variate</span></a>
        
        <span class="result"> extends Error with Combinatorics</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This abstract class serves as a base class for all the random variate (RV)
generators.</p>
    </li><li visbl="pub" name="scalation.random.Weibull" data-isabs="false">
      <a id="Weibull:Weibull"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="Weibull.html"><span class="name">Weibull</span></a>
        
        <span class="params">(<span name="alpha">alpha: Double</span>, <span name="beta">beta: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates Weibull random variates.</p>
    </li><li visbl="pub" name="scalation.random._HyperExponential" data-isabs="false">
      <a id="_HyperExponential:_HyperExponential"></a>
      <h4 class="signature">
      <span class="kind">case class</span>
      <span class="symbol"> 
        <a href="_HyperExponential.html"><span class="name">_HyperExponential</span></a>
        
        <span class="params">(<span name="mu">mu: Double</span>, <span name="sigma">sigma: Double</span>, <span name="stream">stream: Int</span>)</span><span class="result"> extends Variate with Product with Serializable</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This class generates HyperExponential random variates.</p>
    </li></ol>
            </div>
        
        

        <div class="values members" id="values">
              <h3>Value Members</h3>
              <ol><li visbl="pub" name="scalation.random.Quantile" data-isabs="false">
      <a id="Quantile:Quantile"></a>
      <h4 class="signature">
      <span class="kind">object</span>
      <span class="symbol"> 
        <a href="Quantile$.html"><span class="name">Quantile</span></a>
        
        <span class="result"> extends Combinatorics with Error</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This object contains methods to compute inverse Cumulative Distribution
Functions (iCDF's) for the popular sampling distributions:
StandardNormal, StudentT, ChiSquare and Fisher.</p>
    </li><li visbl="pub" name="scalation.random.QuantileTest" data-isabs="false">
      <a id="QuantileTest:QuantileTest"></a>
      <h4 class="signature">
      <span class="kind">object</span>
      <span class="symbol"> 
        <a href="QuantileTest$.html"><span class="name">QuantileTest</span></a>
        
        <span class="result"> extends App</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
This object test the the Quantile object.</p>
    </li><li visbl="pub" name="scalation.random.RNG" data-isabs="false">
      <a id="RNG:RNG"></a>
      <h4 class="signature">
      <span class="kind">object</span>
      <span class="symbol"> 
        <a href="RNG$.html"><span class="name">RNG</span></a>
        
        <span class="result"> extends AnyRef</span>
      </span>
      </h4>
      <p class="comment cmt">The Random Number Generator (RNG) object provides multiple pre-built
 random number streams.</p>
    </li><li visbl="pub" name="scalation.random.SeedFinder" data-isabs="false">
      <a id="SeedFinder:SeedFinder"></a>
      <h4 class="signature">
      <span class="kind">object</span>
      <span class="symbol"> 
        <a href="SeedFinder$.html"><span class="name">SeedFinder</span></a>
        
        <span class="result"> extends App</span>
      </span>
      </h4>
      <p class="comment cmt">The SeedFinder object find seeds for all the random number streams.</p>
    </li><li visbl="pub" name="scalation.random.VariateTest" data-isabs="false">
      <a id="VariateTest:VariateTest"></a>
      <h4 class="signature">
      <span class="kind">object</span>
      <span class="symbol"> 
        <a href="VariateTest$.html"><span class="name">VariateTest</span></a>
        
        <span class="result"> extends App</span>
      </span>
      </h4>
      <p class="comment cmt">::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
Conduct two simple tests of the Random Variate Generators: (1) Means Test
(2) Goodness of Fit Test.</p>
    </li></ol>
            </div>

        

      </div>
      
      <div id="tooltip"></div>
      
    </body>
      </html>